Skip to content

docs: add SECURITY.md - #80

Merged
vyruss merged 2 commits into
mainfrom
docs/security-policy
Aug 21, 2026
Merged

docs: add SECURITY.md#80
vyruss merged 2 commits into
mainfrom
docs/security-policy

Conversation

@AntTheLimey

@AntTheLimey AntTheLimey commented Aug 20, 2026

Copy link
Copy Markdown
Member

Adds SECURITY.md to the repository root. It names security@pgedge.com as
the single reporting route and points at the pgEdge Vulnerability Disclosure
Statement for scope, safe harbour and CVE handling.

The file is identical in every pgEdge product repository — nothing in it is
repo-specific.

Why an in-repo copy when there is an org default

pgEdge/.github carries the same file as an organisation default, which covers
every repository that has none of its own. Defaults do not appear in a
repository's file tree, git history, clones or release archives — only in the
Security tab. A product a customer clones or vendors should carry its own
policy, and OpenSSF Scorecard's security-policy check only looks in the
repository itself.

Draft on purpose — merge order matters

The only link in this file is https://docs.pgedge.com/security, and that URL
returns 404 today. Merging before the statement is live publishes a
security policy whose one actionable link is dead.

Merge order:

  1. docs: add vulnerability disclosure statement pgedge-docs#138 — publishes docs.pgedge.com/security. Out of
    draft and awaiting review.
  2. docs: add org-wide SECURITY.md default .github#6 — the org-wide default.
  3. This PR, alongside the other product repositories.

No action needed from you until #138 merges. Reviews welcome now.

Also removes .github/SECURITY.md

This repository already carried its own policy at .github/SECURITY.md. It
directed reporters to security/advisories/new — GitHub's private
vulnerability reporting form, which is disabled across the pgEdge org and stays
disabled — so the link was dead, and there was no email fallback. It also
promised a fix timeline, which has not been approved.

A file in .github/ takes precedence over one in the repository root, so the
new root file does not supersede it on its own. It has to go in the same PR or
coldfront keeps serving the dead link.

Points at security@pgedge.com as the single reporting route and at the
pgEdge Vulnerability Disclosure Statement for scope, safe harbour and CVE
handling. Identical across every pgEdge product repository.

Do not merge before pgEdge/pgedge-docs#138 publishes
docs.pgedge.com/security; until it does, the only link in this file 404s.
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4be9eec2-65cd-4fb5-a2b1-06a4577ebe02

📥 Commits

Reviewing files that changed from the base of the PR and between 26a8130 and 2b4594d.

📒 Files selected for processing (2)
  • .github/SECURITY.md
  • SECURITY.md
💤 Files with no reviewable changes (1)
  • .github/SECURITY.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request removes .github/SECURITY.md and adds SECURITY.md with vulnerability reporting, response, supported-version, testing, safe-harbour, and advisory publication guidance.

Changes

Repository security policy

Layer / File(s) Summary
Security policy terms
.github/SECURITY.md, SECURITY.md
The GitHub security policy is removed. A root-level policy defines vulnerability reporting, response timelines, supported versions, testing authorization, safe-harbour terms, and advisory publication.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: 🟡 Moderate · up to 2b459

This change replaces the repository’s dead reporting-form route with an email address and a documentation link, but the linked security page is currently reported as returning 404. Merging now would publish a policy with a dead actionable link, so merge should wait for the documentation update or explicit acceptance.

Suggested reviewers: vyruss

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the addition of the repository-level SECURITY.md file, which is the main change.
Description check ✅ Passed The description accurately explains the new root policy, removal of the obsolete policy, reporting route, and merge dependency.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/security-policy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codacy-production

codacy-production Bot commented Aug 20, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

It pointed reporters at security/advisories/new, GitHub's private
vulnerability reporting form. That is disabled org-wide and stays
disabled, so the link is dead and the file offered no email fallback.

It also promised a fix timeline, which is not something we have
approved. A file in .github/ takes precedence over one in the root, so
the new root SECURITY.md does not supersede it on its own.
@vyruss
vyruss marked this pull request as ready for review August 21, 2026 12:07
@vyruss
vyruss self-requested a review as a code owner August 21, 2026 12:07
@vyruss
vyruss merged commit 0f6ff0a into main Aug 21, 2026
9 of 10 checks passed
@vyruss
vyruss deleted the docs/security-policy branch August 21, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants